Skip to content

Align repository with DPC conventions#11

Merged
dmccoystephenson merged 5 commits intomainfrom
copilot/align-repo-with-dpc-conventions
Mar 22, 2026
Merged

Align repository with DPC conventions#11
dmccoystephenson merged 5 commits intomainfrom
copilot/align-repo-with-dpc-conventions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 22, 2026

Adds all required documentation files and restructures README.md to match the DPC conventions.

README.md

  • Rewritten with the 10 required sections in canonical order: Description → Installation → Usage → Support → Contributing → Testing → Development → Authors and Acknowledgement → License → Project Status
  • Usage section now links to all in-repo doc files

New documentation files

  • CONTRIBUTING.md — Fork/branch/PR workflow, links, requirements, testing instructions
  • USER_GUIDE.md — Prerequisites, first steps, common scenarios (Discord, email, custom messages)
  • COMMANDS.md — Documents that Herald exposes no commands (config-driven)
  • CONFIG.md — Every config.yml option with type, default, description, and example
  • CHANGELOG.mdKeep a Changelog format with initial [1.0.0] release

Version bump

  • build.gradle — Version updated from 0.1.0-SNAPSHOT to 1.0.0

CI

  • .github/workflows/build.yml — DPC-standard workflow: ./gradlew clean build on push/PR to main/develop, JDK 21 (matches build.gradle target), explicit permissions: contents: read

Dev tooling

  • reload-plugin.sh — Builds JAR, copies into running Docker container, triggers ServerUtils reload

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI and others added 3 commits March 22, 2026 15:24
Restructure README.md, add CONTRIBUTING.md, USER_GUIDE.md, COMMANDS.md,
CONFIG.md, CHANGELOG.md, .github/workflows/build.yml, and reload-plugin.sh.

Reference: https://github.com/Dans-Plugins/dpc-conventions

Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Dans-Plugins/Herald/sessions/2d04014b-13a7-49b7-af49-11c01bb837d0
Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Dans-Plugins/Herald/sessions/2d04014b-13a7-49b7-af49-11c01bb837d0
Copilot AI changed the title [WIP] Align repository with DPC conventions Align repository with DPC conventions Mar 22, 2026
Copilot AI requested a review from dmccoystephenson March 22, 2026 15:27
CHANGELOG.md Outdated

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this version 1.0.0 and modify any other files as necessary

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated CHANGELOG.md to [1.0.0] and bumped build.gradle version from 0.1.0-SNAPSHOT to 1.0.0 in c14aba8.

Co-authored-by: dmccoystephenson <21204351+dmccoystephenson@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Dans-Plugins/Herald/sessions/840edecb-6910-4da4-a39a-39d2336a9828
@dmccoystephenson dmccoystephenson marked this pull request as ready for review March 22, 2026 16:06
Copilot AI requested a review from dmccoystephenson March 22, 2026 16:07
@dmccoystephenson dmccoystephenson merged commit 12edf79 into main Mar 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants